Ficha técnica

Alcances necesarios

El token para consumir la API de Pagos debe ser generado utilizando el Authorization Code.

El alcance openid es obligatorio. Permite consultar el perfil del usuario BTG con acceso a la cuenta.

Es necesario elegir uno de los siguientes alcances:

Alcance	Descripción
brn:btg:empresas:payment-link	Permite la creación y gestión de links de pago y la recepción de webhooks.
brn:btg:empresas:payment-link.readonly	Permite la consulta de links de pago y la recepción de webhooks.

Eventos de webhook

Los payloads disponibles a continuación representan el contenido del campo data, siguiendo el formato de envío descrito en Eventos.

Por seguridad, el taxId del pagador (payer.taxId) se envía enmascarado en los payloads de webhook.

Evento	Descripción
payment-link.created	Link de pago creado.
payment-link.activated	Link de pago activado.
payment-link.paid	Link de pago pagado.
payment-link.updated	Link de pago actualizado.
payment-link.expired	Link de pago expirado.
payment-link.cancelled	Link de pago cancelado.
payment-link.failed	Error en el procesamiento del link de pago.

payment-link.created

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-07-30",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}

payment-link.activated

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-07-30",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}

payment-link.paid

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-08-11",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}

payment-link.updated

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-08-11",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}

payment-link.expired

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-08-15",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}

payment-link.cancelled

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-08-11",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}

payment-link.failed

{
  "id": "8d241f83-6d04-457b-9cd4-eebc253a34fd",
  "name": "Link de pagamento teste",
  "payee": {
    "name": "COMDATA TELECOM LTDA",
    "personType": "J",
    "taxId": "50523744000169",
    "accountNumber": "008656317"
  },
  "payer": {
    "name": "JUAREZ BASTOS CUNHA",
    "personType": "F",
    "taxId": "***414325**"
  },
  "amount": 149,
  "paymentMethods": ["BANKSLIP"],
  "schedule": {
    "startAt": "2025-07-30T11:26:55.772Z",
    "endAt": "2025-08-15T11:26:55.772Z"
  },
  "createdAt": "2025-07-30",
  "updatedAt": "2025-08-11",
  "origin": "DEVELOPERS",
  "deliveryMediums": [],
  "linkUrl": "https://link.btgpactual.com/8d241f83",
  "type": "SINGLE"
}